Skip to main content
GET
/
v1
/
system
/
users
/
{type}
List all Users
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/system/users/{type} \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "type": "OrganizationUser",
      "id": 3,
      "name": "Bernard Greensmith",
      "email": "admin@example.com",
      "username": "b.greensmith",
      "is_active": true,
      "roles": [
        {
          "type": "OrganizationUserRole",
          "id": 3
        }
      ],
      "login_via_badge": true,
      "default_warehouse": {
        "type": "Warehouse",
        "id": 123
      }
    }
  ],
  "included": {
    "ClientUserRole": [
      {
        "type": "ClientUserRole",
        "id": 3,
        "name": "Administrators",
        "permissions": [
          "warehouse",
          "warehouse/staff",
          "warehouse/staff/time_entry_log",
          "warehouse/staff/time_management",
          "warehouse/staff/time_management/excluded",
          "warehouse/staff/time_management/status_dashboard"
        ]
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "OrganizationUserRole": [
      {
        "type": "OrganizationUserRole",
        "id": 3,
        "name": "Administrators",
        "permissions": [
          "warehouse",
          "warehouse/staff",
          "warehouse/staff/time_entry_log",
          "warehouse/staff/time_management",
          "warehouse/staff/time_management/excluded",
          "warehouse/staff/time_management/status_dashboard"
        ]
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  },
  "has_more": true,
  "next": "<string>",
  "previous": "<string>",
  "meta": {
    "processing_time": 0.2525252525,
    "cursor_start": 123,
    "cursor_end": 123,
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client

Query Parameters

​
fields
enum<string>[]

Specify additional fields of the OrganizationUser or ClientUser objects to be included in the response. See the selecting fields page for more information.

​
fields:roles
enum<string>[]

Specify additional fields of the OrganizationRole or ClientRole object to be included in the response. See the selecting fields page for more information.

​
fields:default_warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response. See the selecting fields page for more information.

​
deleted
enum<string>

Deleted users are not returned by default. Pass this parameter with the value true to return only deleted users.

Available options:
true
​
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • name
  • email
  • username
  • is_active
  • created_at
  • last_login_at
​
sort
string

The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:

  • id
  • username
  • created_at
  • last_login_at
  • email
​
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
​
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

​
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

​
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

A dictionary with a collection property that contains an array of up to limit User objects. If no users are found the array will be empty.

​
collection
(OrganizationUser · object | ClientUser · object)[]
  • OrganizationUser
  • ClientUser
​
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

​
has_more
boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

​
next
string | null

The resource path for the next page of results if any are expected.

​
previous
string | null

The resource path for the previous page of results if any are expected.

​
meta
object

Additional metadata pertaining to the response.